/*
 *  Copyright 2004 Blandware (http://www.blandware.com)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.blandware.atleap.webapp.taglib.core.grid.util;

import java.io.Serializable;

/**
 * <p>Interface for grid filters</p>
 * <p><a href="GridFilter.java.html"><i>View Source</i></a></p>
 *
 * @author Sergey Zubtsovskiy <a href="mailto:sergey.zubtsovskiy@blandware.com">&lt;sergey.zubtsovskiy@blandware.com&gt;</a>
 * @version $Revision: 1.6 $ $Date: 2006/08/03 10:08:22 $
 */
public interface GridFilter extends Serializable {

	/**
	 * Returns field name this filter is associated with
	 *
	 * @return field name
	 */
	public String getFieldName();

	/**
	 * Returns condition created by filter object, if it is enabled for iterator with specified ID.
     * Otherwise <code>null is returned.</code>
	 *
	 * @return String with condition
	 */
	public String getClause(String iteratorId);

}
